﻿/***************************************************************************
	Copyright (C) 2010 RapidWebDev Organization (Author: Eunge, Legal Name: Jian Liu, Email: eunge.liu@gmail.com)

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ***************************************************************************/

using System;
using System.IO;
using System.Data;
using System.Collections;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Configuration;
using System.Linq;
using System.Text.RegularExpressions;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.HtmlControls;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Xml.Linq;
using BaoJianSoft.Web.Extensions.Controls;

namespace BaoJianSoft.Web.Extensions.DynamicPages
{
	/// <summary>
	/// Interface to parse input excel document.
	/// </summary>
	public interface IExcelParser
	{
		/// <summary>
		/// Set/get ExcelDocument on how to parse excel document.
		/// </summary>
		ExcelDocument Document { get; set; }

		/// <summary>
		/// On attaching child controls.
		/// </summary>
		/// <param name="detailpanel"></param>
		void OnAttachChildControls(ExcelDetailPanelControl detailpanel);

		/// <summary>
		/// Fires on validating excel cell value parsing to property value.
		/// </summary>
		/// <param name="e"></param>
		void OnValidatingPropertyValue(ExcelValidatingFieldEventArgs e);

		/// <summary>
		/// Fires on parsing excel cell value to property value.
		/// </summary>
		/// <param name="e"></param>
		void OnParsingPropertyValue(ExcelParsingPropertyEventArgs e);

		/// <summary>
		/// Fires on saving objects parsed from uploaded excel document.
		/// </summary>
		/// <param name="objectsUploaded"></param>
		void OnSaving(ExcelParserObjectEventArgs e);

		/// <summary>
		/// Fires after saved objects parsed from uploaded excel document.
		/// </summary>
		/// <param name="e"></param>
		void OnSaved(ExcelParserObjectEventArgs e);

		/// <summary>
		/// Returns dataset composes of two datatable, Success and Failure.
		/// </summary>
		/// <param name="excelFilePath"></param>
		/// <returns></returns>
		DataSet Parse(string excelFilePath);

		/// <summary>
		/// Parse uploaded dataset to instance typed in DocumentObjectType.
		/// </summary>
		/// <param name="dataSet"></param>
		/// <returns></returns>
		IList Parse(DataSet dataSet);
	}
}
